[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
HelpKeys () --> true/false:
~~~~~~~~~~~~~~~~~~~~~~~~~~

Functions:
~~~~~~~~~~
This function is activated when user pressed F1 key or SHIFT-F1. It presents
the used keys description as help for the user. Displayed are the text
strings selected by SaveHelpIdx() funct.

Parameter description:
~~~~~~~~~~~~~~~~~~~~~~
nil

Return value:
~~~~~~~~~~~~~
true

Remarks:
~~~~~~~~
The text strings are stored in twodimensional array in HelpKeys() function.
Displayed are the subarrays selected by the SaveHelpIdx(). The input
parameter is the index list to array of text strings inside of HelpKeys().

Example:
~~~~~~~~
     SaveHelpIdx( {1,2,5,6} )
     HelpKeys()
     RestHelpIdx()
     ...
The SaveHelpIdx() function stores the current information about the subarrays
to display, and prepares the subarrays 1,2,5 and 6 to be displayed by
HelpKeys(). Activating of it is the help text dispplayed (the subaarrays
1,2,5 and 6). The restHelpIdx() function restores the previous status of
help displaying.

Source code is in file  Object2.prg

See Also: SaveHelpIdx RestHelpIdx
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson